Copies a subresource of a source image to a destination image. More...

#include <kanzi/gfx/commands.hpp>

Inheritance diagram for kanzi::gfx::CopyImageCommand:

Public Member Functions
	CopyImageCommand ()
	Constructor.

Public Member Functions inherited from kanzi::gfx::BaseCommand
uint32_t	getSize () const
	Gets the command size in bytes.

uint8_t	getTag () const
	Gets the command tag.

CommandType	getType () const
	Gets the command type.

void	setTag (uint8_t tag)
	Sets the command tag.

Public Attributes
ImageHandleGuard	destinationImage
	The destination image. Must have ImageUsageFlag::CopyDestination.

v3u32	destinationOffset
	The offset of the destination image region.

ImageSubresource	destinationSubresource
	The subresource of the destination image.

v3u32	size
	The size of the copy region in pixels.

ImageHandleGuard	sourceImage
	The source image. Must have ImageUsageFlag::CopySource.

v3u32	sourceOffset
	The offset of the source image region.

ImageSubresource	sourceSubresource
	The subresource of the source image.

Additional Inherited Members
Protected Member Functions inherited from kanzi::gfx::BaseCommand
	BaseCommand (CommandType t, uint32_t s)
	Constructor.

	BaseCommand (const BaseCommand &other)
	Copy Constructor.

BaseCommand &	operator= (const BaseCommand &other)
	Assignment operator.

Detailed Description

Copies a subresource of a source image to a destination image.

Since: Kanzi 4.0.0

Constructor & Destructor Documentation

◆ CopyImageCommand()

kanzi::gfx::CopyImageCommand::CopyImageCommand ( )

inline

Constructor.

Member Data Documentation

◆ sourceImage

ImageHandleGuard kanzi::gfx::CopyImageCommand::sourceImage

The source image. Must have ImageUsageFlag::CopySource.

◆ destinationImage

ImageHandleGuard kanzi::gfx::CopyImageCommand::destinationImage

The destination image. Must have ImageUsageFlag::CopyDestination.

◆ sourceSubresource

ImageSubresource kanzi::gfx::CopyImageCommand::sourceSubresource

The subresource of the source image.

◆ destinationSubresource

ImageSubresource kanzi::gfx::CopyImageCommand::destinationSubresource

The subresource of the destination image.

◆ sourceOffset

v3u32 kanzi::gfx::CopyImageCommand::sourceOffset

The offset of the source image region.

◆ destinationOffset

v3u32 kanzi::gfx::CopyImageCommand::destinationOffset

The offset of the destination image region.

◆ size

v3u32 kanzi::gfx::CopyImageCommand::size

The size of the copy region in pixels.

When the maximum value is specified, the size represents the rest of the source image.

The documentation for this struct was generated from the following file:

kanzi/gfx/commands.hpp

Public Member Functions

Public Attributes

Additional Inherited Members